Crate user_doc_doc_data

Metadata regarding user-facing documentation

Structs

• DocDict
  A (possibly-nested) dictionary of docs
• HelperAttrIter

Enums

• DirectoryNamingScheme
  When expanding to directories, this determines the naming scheme
• Documentable
  A documentation or a Docdict Each documentable has a name string
• HelperAttr
  Attribute helpers

Constants

• PREVIEW_TEXT_LENGTH
  How much text to show in previews

Statics

• CUSTOM_OUTPUT_FILE_NAME
  Custom output file path for persisting data
• DOCS
  The repository of all active docs
• OUTPUT_DIR_PATH
  Output directory for persisting data between compilation-time and run-time

Functions

• get_persistence_dir_path
  Get the persistence directory path
• get_persistence_file_path
  Get the full persistence directory+file path
• load_global_docs
  Load the docs from a file path
• make_string_key
  Make a string from a DocDict key
• persist_docs
  Save the global store to a file

Type Definitions

• DocDictEntryValueType
  Entries in the DocDict take this form
• DocDictTree
  A tree-dictionary of docs
• HeaderLevel
  The level of a markdown header